<?php 

//
// Open Web Analytics - An Open Source Web Analytics Framework
//
// Copyright 2008 Peter Adams. All rights reserved.
//
// Licensed under GPL v2.0 http://www.gnu.org/copyleft/gpl.html
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// $Id$
//

/**
 * Service User Class
 * 
 * @author      Peter Adams <peter@openwebanalytics.com>
 * @copyright   Copyright &copy; 2008 Peter Adams <peter@openwebanalytics.com>
 * @license     http://www.gnu.org/copyleft/gpl.html GPL v2.0
 * @category    owa
 * @package     owa
 * @version		$Revision$	      
 * @since		owa 1.0.0
 */


class owa_serviceUser extends owa_base {
	/**
	 * @var owa_user
	 */
	public $user;
	var $capabilities = array();
	var $preferences = array();
	var $is_authenticated = false;
	public $assignedSites = array();
	private $isInitialized = false;
	private $isAssignedSitesListLoaded = false;
	
	function __construct() {
		//parent::__construct();
		// create empty user entity
		$this->user = owa_coreApi::entityFactory('base.user');
		// set default role
		$this->setRole('everyone');
	}
	
	/**
	 * Loads Current user based on user_id
	 * This method should only used if the user is authenticated.
	 *
	 * @param $user_id	string	the user_id
	 * @depricated
	 */
	function load( $user_id = '' ) {
		
		if (! $user_id ) {
			
			// if there is no user_id and role is everyone
			// procead with loading sites and 
			//if ( $this->isAnonymousUser() ) {
			//	return $this->initInternalProperties();
			//} else {
				throw new Exception('No valid userid given!');
			//}
		}
		
		// if there is a user_id load the user object and other properties.
		$this->user->load($user_id, 'user_id');			
		$this->initInternalProperties();
	}
	
	/**
	 * Loads the current user from an owa_user object 
	 * owa_auth uses this after the user is authenticated
	 *
	 * @param $user_obj	object	owa_user object
	 */
	function loadNewUserByObject($user_obj) {
		$this->user = $user_obj;
		$this->initInternalProperties();
	}
	
	private function initInternalProperties() {
		$this->loadRelatedUserData();
		$this->loadAssignedSites();
		$this->setInitialized();
	}
	
	function loadRelatedUserData() {		
		$this->capabilities = $this->getCapabilities($this->user->get('role'));
		$this->preferences = $this->getPreferences($this->user->get('user_id'));
		
	}
	/**
	 * gets allowed capabilities for the user role
	 * @param unknown_type $role
	 */
	function getCapabilities($role) {		
		return owa_coreAPI::getCapabilities( $role );	
	}
	
	function getPreferences($user_id) {		
		return false;
	}
	
	function getRole() {		
		return $this->user->get('role');
	}
	
	/**
	 * Sets role and related capabilities
	 *
	 * @param	$value	string	the user's role
	 */
	function setRole($value) {
		
		$this->user->set('role', $value);
		$this->capabilities = $this->getCapabilities($value);
	}
	
	function setUserData($name, $value) {
		
		$this->user->set($name, $value);
	}
	
	function getUserData($name) {
		
		return $this->user->get($name);
	}
	
	/**
	 * Checks if user has a partciular capability
	 *
	 * @param string 	$cap
	 * @param integer 	$siteId	only needed if capability requires site access. you need to pass site_id (not id) field
	 * @return boolean
	 */
	function isCapable($cap, $siteId = null) {
		owa_coreAPI::debug("Checking if user is capable of: ".$cap);
		
		// is this capability assigned to everyone? 
		// is this the global admin user?
		// was no capability passed?
		// if so, the user can see and do everything
		if ( owa_coreAPI::isEveryoneCapable( $cap ) || $this->user->isAdmin() || empty($cap)) {
			owa_coreAPI::debug('No capability passed or user is an admin and capable of everything.');
			return true;
		}
		
		// is this user's role capable?
		if (!in_array($cap, $this->capabilities)) {
			owa_coreAPI::debug('capability does not exist for this role. user is not capable');
			return false;	
		}
		
		// Does capability also require site access?
		if ( $this->isSiteAccessRequiredForCapability( $cap ) ) {
			owa_coreAPI::debug('Site access required for this capability.');
			if ( ! $this->isSiteAccessible( $siteId ) ) {
				owa_coreAPI::debug('Site is not accessible for this user.');
				return false;
			} else {
				owa_coreAPI::debug('Site is accessible for this user.');
			}
		}
		
		return true;
	}
	
	/**
	 * Checks to see if the Capability requires
	 * user to pass site access control check
	 *
	 * @param	$capability	string	the name of the capability (e.g. 'view_reports')
	 * @return	boolean
	 */
	function isSiteAccessRequiredForCapability( $capability ) {
		
		$capabilitiesThatRequireSiteAccess = owa_coreAPI::getSetting('base', 'capabilitiesThatRequireSiteAccess');
		if (is_array($capabilitiesThatRequireSiteAccess) && in_array($capability, $capabilitiesThatRequireSiteAccess)) {
			return true;
		}
	}
	
	/**
	 * Checks to see if the a site is accessible to a user
	 *
	 * @param	string	$siteId	the siteId of the site in question
	 * @return	boolean
	 */
	function isSiteAccessible( $siteId ) {
		
		if ( is_null($siteId) ) {
			throw new InvalidArgumentException('Cannot tell if site is accessible to user without a siteId (none given).');
		}
		
		if ( $this->user->isAdmin() ) {
			return true;
		}
		
		if ( ! $this->isAssignedSitesListLoaded ) {
			//$this->loadAssignedSites();	
		}
		
		if ( isset( $this->assignedSites[ $siteId ] ) ) {
			owa_coreAPI::debug("Site ID: $siteId in accessible list for this user.");
			return true;
		} else {
			owa_coreAPI::debug("Site ID: $siteId is not in accessible list for this user.");
		}
	}
	
	// mark the user as authenticated and populate their capabilities	
	function setAuthStatus($bool) {		
		$this->is_authenticated = true;
	}	
	
	function isAuthenticated() {		
		return $this->is_authenticated;
	}
	
	
	/**
	 * Loads internal $this->assignedSites member
	 */
	private function loadAssignedSites() {
		owa_coreAPI::debug('loading assigned sites');	
		if ( ! $this->user->get( 'id' ) ) {
	 		throw new Exception('no user object loaded!');
		}
		
		$site_ids = array();
		$db = owa_coreAPI::dbSingleton();		
		$db->selectFrom( 'owa_site_user' );
		$db->selectColumn( '*' );
		$db->where( 'user_id', $this->user->get('id') );
		$site_ids = $db->getAllRows();
		
		// filter array of site_ids.
		$dispatch = owa_coreAPI::getEventDispatch();
		$site_ids = $dispatch->filter('allowed_sites_list', $site_ids);
		
		$this->setAllowedSitesList($site_ids);
	}
	
	public function setInitialized() {
		$this->isInitialized = true;
	}
	
	public function loadAssignedSitesByDomain($domains) {
		
		if ( $domains ) {
			$site_ids = array();
			$s = owa_coreApi::entityFactory('base.site');
			
			foreach ($domains as $domain) {
				
				$site_ids[] = array('site_id' => $s->generateId( $s->generateSiteId( $domain ) ) );
			}
			
			$this->setAllowedSitesList($site_ids);
		}
	}
	
	private function setAllowedSitesList($site_ids) {
		
		$list = array();
		
		if ( ! empty($site_ids) ) {		
			foreach ($site_ids as $row) {
				$siteEntity = owa_coreApi::entityFactory('base.site');
				$siteEntity->load($row['site_id']);
				$list[ $siteEntity->get('site_id') ] = $siteEntity;
			}
		}
		
		$this->assignedSites = $list;
		$this->isAssignedSitesListLoaded = true;
	}
	
	public function getAssignedSites() {				
				
		return $this->assignedSites;
	}
	

	public function isOWAAdmin() {
		
		return $this->user->isOWAAdmin();
	}
	
	public function isAdmin() {
		
		return $this->user->isAdmin();
	}
	
	public function isAnonymousUser() {
		$role = $this->getRole();
		if ( ! $this->user->get('user_id') && $this->getRole() === 'everyone') {
			return true;
		} else {
			return false;
		}
	}
}



?>